package com.eedi.framework.sms.service;

import com.eedi.framework.common.pojo.PageResult;
import com.eedi.framework.sms.controller.sys.vo.template.SysSmsTemplatePageReq;
import com.eedi.framework.sms.controller.sys.vo.template.SysSmsTemplateSaveReq;
import com.eedi.framework.sms.dal.dataobject.SysSmsTemplateDO;
import com.eedi.framework.sms.enums.SmsSceneEnum;

import javax.validation.Valid;


/**
 * 短信模板 Service 接口
 *
 * @author 永聚长青源码
 */
public interface SmsTemplateService {

    /**
     * 创建短信模板
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    String createSmsTemplate(@Valid SysSmsTemplateSaveReq createReqVO);

    /**
     * 更新短信模板
     *
     * @param updateReqVO 更新信息
     */
    void updateSmsTemplate(@Valid SysSmsTemplateSaveReq updateReqVO);

    /**
     * 删除短信模板
     *
     * @param systemSmsTemplateId 编号
     */
    void deleteSmsTemplate(String systemSmsTemplateId);

    /**
     * 获得短信模板
     *
     * @param systemSmsTemplateId 编号
     * @return 短信模板
     */
    SysSmsTemplateDO getSmsTemplate(String systemSmsTemplateId);

    /**
     * 获得短信模板分页
     *
     * @param pageReqVO 分页查询
     * @return 短信模板分页
     */
    PageResult<SysSmsTemplateDO> getSmsTemplatePage(SysSmsTemplatePageReq pageReqVO);

    SysSmsTemplateDO getSmsTemplate(SmsSceneEnum smsSceneEnum);

}
